DESCRIPTION¶

INTRODUCTION¶

SYNTAXE DU FICHIER DE CONFIGURATION¶

Spécifier un modèle pour les différentes langues

Spécifier les chemins des fichiers des traducteurs

Détection automatique des chemins et langues

Spécification des documents à traduire

Fournir des options aux modules

Spécifier des alias

Mode réparti

OPTIONS¶

EXEMPLE¶

DÉFAUTS¶

VOIR AUSSI¶

AUTEURS¶

COPYRIGHT ET LICENCE¶

Spécifier un modèle pour les différentes langues¶

Note : L'utilisation de [po_directory] est préférable à [po4a_langs] et [po4a_paths] (voir Détection automatique des chemins et langues plus bas).

C'est une commande optionnelle qui permet de simplifier le fichier de configuration lorsqu'il est utilisé pour de nombreuses langues. Il vous suffit de spécifier les langues vers lesquelles vous voulez traduire les documents, ce qui se fait aussi simplement que :

 [po4a_langs] fr de

Ceci vous permettra de développer $lang dans toutes les langues spécifiées pour le reste du fichier de configuration.

Spécifier les chemins des fichiers des traducteurs¶

Note : L'utilisation de [po_directory] est préférable à [po4a_langs] et [po4a_paths] (voir Détection automatique des chemins et langues plus bas).

D'abord, vous devez spécifier où se trouvent les fichiers fournis aux traducteurs. Ceci peut être fait de la façon suivante :

 [po4a_paths] doc/l10n/project.doc.pot \
              fr:doc/l10n/fr.po de:doc/l10n/de.po

La commande est donc [po4a_paths]. Le premier paramètre est le chemin du fichier POT à utiliser. Les autres paramètres se comprennent par eux-mêmes :

    <langue>:<chemin vers le fichier PO de cette langue>

Si vous avez défini un modèle pour les langues, vous pouvez écrire la ligne précédente de cette façon :

 [po4a_paths] doc/l10n/project.doc.pot $lang:doc/l10n/$lang.po

Vous pouvez également utiliser $master pour faire référence au nom (sans le chemin) du document. Dans ce cas, po4a utilisera un mode réparti : un POT et un PO (par langue) sera créé pour chaque document présent dans le fichier de configuration de po4a. Consultez la section Mode réparti.

 [po4a_paths] doc/$master/$master.pot $lang:doc/$master/$lang.po

Détection automatique des chemins et langues¶

Une autre commande peut être utilisée pour indiquer le nom d'un répertoire où se trouvent les fichiers PO et POT. Quand elle est utilisée, po4a détectera le fichier POT comme le seul fichier *.pot du répertoire indiqué. po4a utilisera aussi la liste de tous les fichiers *.po pour définir la liste des langues (en enlevant l'extension). Ces langues seront utilisées pour la substitution de la variable $lang dans le reste du fichier de configuration.

Cette commande ne doit pas être utilisée avec les commandes [po4a_langs] ou [po4a_paths].

Lors de l'utilisation de cette commande, il est nécessaire de créer un fichier POT vide pour le premier appel à po4a afin qu'il connaisse le nom du fichier POT.

 [po_directory] po4a/po/

Spécification des documents à traduire¶

Vous devez maintenant spécifier quels documents doivent être traduits, leur format et où placer leurs traductions. Ceci peut être fait par ces lignes :

 [type: sgml] doc/my_stuff.sgml fr:doc/fr/mon_truc.sgml \
              de:doc/de/mein_kram.sgml
 [type: pod] script fr:doc/fr/script.1 de:doc/de/script.1 \
             add_fr:doc/l10n/script.fr.add

Ceci est plutôt explicite. Notez que dans le second cas, doc/l10n/script.fr.add est un addendum à ajouter à la version française du document. Veuillez vous référer à po4a(7) pour plus d'informations à propos des addenda.

Plus formellement, le format est le suivant :

 [type: <format>] <doc_maître> (<lang>:<doc_traduit>)* \
                  (add_<lang>:<modificateur>*<addendum>)*

En absence de modificateurs, addendum est le chemin vers un addendum. Les modificateurs sont :

?

Inclure l'addendum si le fichier existe, rien sinon.

@

addendum n'est pas un fichier addendum normal mais un fichier contenant une liste d'addenda, un par ligne. Chaque addendum peut être précédé de modificateurs.

!

addendum n'est pas pris en compte, il n'est pas chargé et ne le sera pas lors de toute autre indication d'addendum.

Si vous avez défini un modèle pour les langues, vous pouvez écrire la ligne précédente de cette façon :

 [type: pod] script $lang:doc/$lang/script.1 \
             add_fr:doc/l10n/script.fr.add

Si toutes les langues ont des addenda situés dans des chemins similaires, vous pourriez également écrire quelque chose comme :

 [type: pod] script $lang:doc/$lang/script.1 \
             add_$lang:doc/l10n/script.$lang.add

Fournir des options aux modules¶

po4a accepte des options qui seront fournies au module. Ces options sont spécifiques au module et sont spécifiées avec l'option -o.

Si vous voulez fournir une option spécifique pour un des documents que vous voulez traduire, vous pouvez la préciser dans le fichier de configuration. Les options sont introduites par le mot clef opt. Les paramètres du mot clef opt doivent être placés entre guillemets s'ils contiennent des espaces (par exemple si vous précisez plusieurs options, ou une option avec un paramètre). Vous pouvez également spécifier des options qui ne s'appliqueront qu'à une seule langue en utilisant le mot clef opt_lang.

Voici un exemple :
[type:man] data-05/test2_man.1 $lang:tmp/test2_man.$lang.1 \
opt:"-k 75" opt_it:"-L UTF-8" opt_fr:-v

Les arguments peuvent contenir des espaces si vous utilisez des guillemets simples ou si vous protégez les guillemets doubles comme ceci :
[po4a_alias:man] man opt:"-o \"mdoc=NAME,SEE ALSO\" -k 20"

Pour préciser les mêmes options pour un jeu de documents, vous pouvez utiliser un alias (consultez la section Spécifier des alias ci-dessous).

Vous pouvez aussi définir des options pour tous les documents du fichier de configuration :
[options] opt:"..." opt_fr:"..."

Spécifier des alias¶

Si vous devez fournir les mêmes options pour plusieurs fichiers, vous avez intérêt à définir un alias de module. Ceci se fait de cette façon :

[po4a_alias:test] man opt:"-k 21" opt_es:"-o debug=splitargs"

Ceci définit un alias de module nommé test, basé sur le module man. L'option -k 21 s'appliquera à toutes les langues et l'option -o debug=splitargs uniquement à l'espagnol.

Cet alias de module peut ensuite être utilisé comme un module normal :

[type:test] data-05/test2_man.1 $lang:tmp/test2_man.$lang.1 \
opt_it:"-L UTF-8" opt_fr:-v

Notez que vous pouvez encore ajouter des options fichier par fichier.

Mode réparti¶

Le mode réparti est utilisé quand $master est utilisé dans la ligne [po4a_paths].

Quand le mode réparti est utilisé, un gros POT et de gros POs sont créés temporairement. Ceci permet de partager les traductions entre tous les POs.

Si deux POs ont deux traductions différentes pour la même chaîne, po4a marquera cette chaîne comme étant approximative (fuzzy) et proposera les deux traductions dans tous les POs qui contiennent cette chaîne. Ensuite, lorsqu'un traducteur mettra à jour la chaîne dans un PO et retirera l'étiquette fuzzy, la traduction de cette chaîne sera mise à jour dans tous les POs automatiquement.

OPTIONS POUR MODIFIER L'EN-TÊTE POT¶

porefs type[,wrap|nowrap]

Indique le format des références. L'argument type peut-être none pour ne pas produire de référence, noline pour ne pas indiquer de numéro de ligne (plus précisément, tous les numéros de ligne sont remplacés par 1), counter pour remplacer le numéro de ligne par un décompte croissant, et full pour inclure des références complètes.

L'argument peut être suivi d'une virgule et d'un des mots clefs wrap ou nowrap. Les références sont écrites par défaut sur une seule ligne. Avec l'option wrap, les références sont placées sur plusieurs lignes, pour imiter le comportement des outils gettext (xgettext and msgmerge). Cette option deviendra la valeur par défaut dans une prochaine version, car elle est plus pertinente. L'option nowrap est disponible pour permettre aux utilisateurs de conserver l'ancien comportement s'ils le désirent.

--msgid-bugs-address adresse@email

Fixe l'adresse à laquelle les bogues des msgid doivent être envoyés. Par défaut, les fichiers POT créés n'ont pas de champ Report-Msgid-Bugs-To.

--copyright-holder chaîne

Fixe le détenteur du copyright dans l'en-tête du fichier POT. La valeur par défaut est « Free Software Foundation, Inc. ».

--package-name chaîne

Fixe le nom du paquet pour l'en-tête du fichier POT. La valeur par défaut est « PACKAGE ».

--package-version chaîne

Fixe la version du paquet pour l'en-tête du fichier POT. La valeur par défaut est « VERSION ».

OPTIONS POUR MODIFIER LES FICHIERS PO¶

--msgmerge-opt options

Options additionnelles pour msgmerge.

Note : $lang sera remplacé par la langue en cours.

--no-previous

Cette option supprime --previous des options passées à msgmerge. Elle permet de prendre en charge les versions de gettext antérieures à 0.16.

--previous

Cette option ajoute --previous aux options passées à msgmerge. Elle nécessite une version 0.16 ou ultérieure de gettext et est activée par défaut.

EXEMPLE¶

Considérons que vous soyez responsable d'un programme truc avec sa page de manuel man/truc.1 naturellement maintenue seulement en anglais. Maintenant, en tant que développeur amont ou responsable aval, vous désirez créer et maintenir la traduction. Vous devez d'abord créer le fichier POT nécessaire à envoyer au traducteur avec po4a-gettextize(1).

Ainsi dans notre cas, nous ferons

 cd man && po4a-gettextize -f man -m truc.1 -p truc.pot

Vous pourrez alors envoyer ce fichier aux listes de traductions adéquates ou le rendre disponible au téléchargement quelque part.

Considérons maintenant que vous receviez trois traductions avant la prochaine publication : de.po (avec un addendum de.add), sv.po et pt.po. Puisque vous n'avez pas l'intention de modifier le ou les fichiers Makefile à chaque nouvelle traduction reçue, vous pouvez utiliser po4a avec le fichier de configuration adéquat dans chaque Makefile. Ce fichier de configuration peut s'appeler po4a.cfg, dans cet exemple, il ressemblerait à :

 [po_directory] man/po4a/po/
 [type: man] man/truc.1 $lang:man/translated/$lang/truc.1 \
            add_$lang:?man/po4a/add_$lang/$lang.add opt:"-k 80"

Dans cet exemple, nous considérons que les pages de manuel créées (ainsi que tous les fichiers PO et addenda) devraient être gardés dans man/translated/$lang/ (respectivement dans man/po4a/po/ et man/po4a/add_$lang/) à l'intérieur du répertoire en cours. Ici le répertoire man/po4a/po/ contiendrait de.po, pt.po et sv.po et le répertoire man/po4a/add_de/ contiendrait de.add.

Remarquez l'utilisation du modificateur ? car seule la traduction allemande (de.po) est accompagnée d'un addendum.

Pour vraiment construire les pages de manuel traduites, vous devrez alors (une seule fois) ajouter la ligne suivante dans la cible build du Makefile adéquat :

        po4a po4a.cfg

Une fois configuré, il ne sera plus nécessaire de modifier le Makefile à chaque nouvelle traduction reçue. Si par exemple l'équipe de traduction française vous envoie fr.po et fr.add, il suffit de les déposer respectivement dans man/po4a/po/ et man/po4a/add_fr/ et la prochaine fois que le programme sera construit, la traduction française sera aussi automatiquement construite dans man/translated/fr/.

Notez que vous avez toujours besoin d'une cible adéquate pour installer les pages de manuel traduites en plus de celles en anglais.

Enfin, si vous ne voulez pas garder les fichiers créés dans le système de gestion de version, vous devriez aussi ajouter cette ligne à la cible clean :
-rm -rf man/translated